Net-Teams - Bookmark Tag user documentation

There are 5 articles associated with the tag user documentation!

#	Total Bookmarks	Article Title/Link and Description
1.	Bookmarks: 0	Great Technical Writing: The User-Product Life Cycle - A Documentation Tool The User-Product Life Cycle (U-PLC) is a powerful tool for the User Document writer. Use the U-PLC to generate the high-level topics for your User Document.THE USER-PRODUCT LIFE CYCLE (U-PLC)Usually, when we think of a Product Life Cycle, we think in terms of the development and production of the Product itself. When writing User Documentation, consider the U-PLC to help you generate all the topics necessary for a complete document. User Documentation should support y...
2.	Bookmarks: 5	Great Technical Writing: Tell Your Users What To Expect OVERVIEWIn your User Documentation, you direct your Reader to perform tasks with your product. If you don't tell your Reader what to expect when performing those tasks, you will have a baffled Reader, resulting in dissatisfaction and expensive calls to technical support.EXAMPLE: REVERSE OSMOSIS WATER FILTERI bought and installed a Reverse Osmosis water filter. The instructions told me to fill, and then empty (the instructions foolishly used the term "dump," which ...
3.	Bookmarks: 0	Great Technical Writing: Make Your Product Fit OVERVIEWMost product documentation sounds like their product is the only thing in the User's life. Such thinking results in User confusion and dissatisfaction. This article presents three real-life examples of this attitude, and what should be done to remedy these unfortunate situations. The article concludes with some techniques for the writer.BACKGROUNDThere are two important facts that User Documentation ignores:1. Your product is a only minor item in your ...
4.	Bookmarks: 0	Benefits Of Creating User Documents In-House OVERVIEWFor small companies, creating their product's User Documentation in-house, provides benefits to the company, to (idle) staff, and to the product. This article describes the benefits and some downsides of producing User Documents in-house.THREE OPTIONSIf you have no in-house writing staff you have three options:1. No User Document for the product. This is NOT a valid option. Every product needs User Documentation. It completes your product package, an...
5.	Bookmarks: 0	Writing Helpful Help – A Minimalism Checklist User documentation is all too often written by programmers for programmers. It tends to focus on the product’s features, rather than the user’s tasks. Generally, programmers aren’t in the ideal position to be writing user documentation. They’re too close to the bits and bytes, and they’re too far from the user. To them, what the product can do tends to be far more important than what the user can do with the product.